home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / bbsutil / sf_31.zip / SFHELP.ZIP / SFHELP.DOC next >
Text File  |  1991-06-24  |  12KB  |  327 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  _____________________________________________________________________________
  18.     ________________                                       ________________
  19.        _____________     DOCUMENTATION FOR: SFHELP.EXE     _____________
  20.           __________  -----------------------------------  __________ 
  21.              _______   Created by Buffalo Creek Software   _______  
  22.                 ____  -----------------------------------  ____   
  23.                   __        Copyright (C) 1987-1991        __
  24.                    _          All rights reserved.         _    
  25.                     _______________________________________
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.                     --------------------------------------
  43.                     ---  Release Date  June 22, 1991  ---
  44.                     --------------------------------------
  45.  
  46.  
  47.  
  48.                                                                     Page 1
  49.  
  50.  
  51. [1]  PURPOSE OF SFHELP.EXE
  52. --------------------------
  53.  
  54.      SFHELP.EXE is a utility designed to create individual help files 
  55. (stored in SPITFIRE.HLP) for the SPITFIRE Bulletin Board System.  The 
  56. very creation and utilization of SFHELP.EXE is with the user in mind.  
  57. When a user needs further instructions about a specific command, he/she
  58. need not go through the burden of having to read over the entire HELP
  59. file just to find the help they need for a certain command.  The very 
  60. essence of SFHELP.EXE is to streamline and expediate the HELP process 
  61. for the new user as well as the experienced user who may be using a
  62. command with which he/she is unfamiliar.
  63.  
  64.  
  65. [2]  USE OF SFHELP.EXE
  66. ----------------------
  67.  
  68.      To boot the utility, simply type in:
  69.  
  70.                                  C>SFHELP
  71.  
  72.      You will then get to the screen where a help-file will be displayed and 
  73. the commands to operate SFHELP will appear. 
  74.  
  75.      The screen will look like this:
  76.  ____________________________________________________________________________
  77.  
  78.                    ╒═════════════════════════════════════════╕ 
  79.                    │    - MAINTAIN SPITFIRE HELP FILE -      │  
  80.                    │         BUFFALO CREEK SOFTWARE          │ 
  81.                    │            913 - 39th Street            │ 
  82.                    │       West Des Moines, Iowa 50265       │ 
  83.                    │ Copyright (C) by Mike Woltz, 1987-1991  │   
  84.                    ╘═════════════════════════════════════════╛
  85.  
  86.  
  87. Record Number [(helpfile #) of (maximum helpfiles)]  "Name Of Command"
  88.  
  89. The purpose for SFHELP.EXE is to break down Help Menus into
  90. individual help screens for any command about which a user
  91. may have a question.  It is more efficient than one large
  92. help menu and saves time on the user's behalf.
  93.  
  94.  
  95.        <+> Next Help Record  <-> Previous Help Record  <A>dd Help Record
  96.              <G>et Help Record   <C>hange Help Record   <Q>uit
  97.  
  98.                                Enter Selection:
  99.  
  100.  ____________________________________________________________________________
  101.  
  102.      Be certain to have SPITFIRE.HLP in the same directory/path as 
  103. SFHELP.EXE, otherwise you have no help record data when you boot this 
  104. utility.  When finished, be certain that SPITFIRE.HLP is in the same 
  105. directory/path as SPITFIRE.EXE!
  106.  
  107.                                                                      Page 2
  108.  
  109.  
  110. [3]  COMMANDS EXPLAINED
  111. -----------------------
  112.  
  113.  
  114.      <+> Next Help Record
  115.          This will allow you to view the help record following the one that
  116.          is currently being displayed on the screen.
  117.  
  118.  
  119.      <-> Previous Help Record
  120.          This allows you to back up one help record from the record currently
  121.          displayed.
  122.  
  123.  
  124.      <A> Add Help Record
  125.          This command enables you to create a new help record that will be
  126.          immediately appended to the tail end of the existing help file.
  127.          
  128.          IMPORTANT!:  Do NOT accumulate more than 50 total help records in
  129.          SPITFIRE.HLP!  (For more on this, refer to Section 4 of this file.)
  130.          
  131.          When you enter a help record, you are restricted to 6 lines with 60
  132.          characters per line.  You must use a ";" to indicate a blank line.
  133.          A "\" is used to indicate no line.
  134.  
  135.  
  136.      <G> Get Help Record
  137.          This allows you to go to a specific help record.  When you enter
  138.          this command, the program will ask for the record's number you wish
  139.          to see.  Simply key in the record number and SFHELP will take you
  140.          directly to that record.
  141.  
  142.  
  143.      <C> Change Help Record
  144.          This command can be used for a dual purpose.  It can be used to
  145.          change a record, should you find a mistake in it, or it can be used
  146.          to overwrite an old help record by entering a new record.
  147.          
  148.          IMPORTANT!:  Do NOT combine or exchange help records!  (For more on
  149.          this, refer to Section 4 of this file.)
  150.  
  151.  
  152.       <Q> Quit
  153.           This command will dump you back to DOS.
  154.           
  155.  
  156. [4]  CURSOR CONTROL
  157. -------------------
  158.      
  159.       When adding or editing a help record the entire six line help screen
  160. is displayed.  Several options are available for positioning the cursor 
  161. around in the help work area.  These are:
  162.  
  163.    Left Arrow Key  - This will move the cursor left 1 character position.
  164.    
  165.    Right Arrow Key - This will move the cursor right 1 character position.   
  166.  
  167.                                                                      Page 3
  168.  
  169.  
  170.  
  171.    Up Arrow Key    - This will move the cursor up 1 line and place the
  172.                      cursor at the beginning of that line.
  173.  
  174.    Down Arrow Key  - This will move the cursor down 1 line and place the 
  175.                      cursor at the beginning of that line.
  176.                      
  177.    End Key         - This will move the cursor to the end of the current line.
  178.    
  179.    Home Key        - This will move the cursor to the beginning of the current
  180.                      line.
  181.                      
  182.    Backspace Key   - This will delete the character to the left of the current
  183.                      cursor position.
  184.                      
  185.    Del Key         - This will delete the character in the current cursor
  186.                      position.
  187.                      
  188.    Escape Key      - When editing a record this will terminate the editing and
  189.                      return you to the main sfhelp screen.
  190.                      
  191.    Insert Key      - The insert key can be used to activate and deactivate the
  192.                      the insert mode.  The present mode is always displayed in 
  193.                      the lower left hand portion of the screen.  It will be 
  194.                      displayed either as Insert Active or Insert Inactive.   
  195.  
  196.  
  197. [5]  HELP RECORD INFORMATION
  198. ----------------------------
  199.   
  200.      There are 3 basic rules that must ALWAYS be followed when working with
  201. SFHELP.EXE!  These rules MUST be followed at all costs.  To do otherwise is
  202. only inviting disaster in this arena of SPITFIRE.
  203.  
  204.  
  205.      [A]  You CANNOT accumulate more than 53 help records!
  206.      ------------------------------------------------------
  207.      To do so is not only useless, but hazardous to the efficiency of
  208.      SPITFIRE!  There are only 53 commands to deal with in SPITFIRE, so
  209.      it stands to reason that there is no need to add help records for 
  210.      commands that do not even exist.
  211.      
  212.      If you attempt to add a new help record and 53 already exist, the  
  213.      message, "The maximum number of records are already written!" is
  214.      displayed to the screen.
  215.  
  216.  
  217.      [B]  You CANNOT combine help records!
  218.      -------------------------------------
  219.      First off, combining help records defeats the entire purpose of SFHELP.
  220.      If one combines the <P>age the Sysop help record with the <C>omment to
  221.      Sysop help record, one is only succeeding in confusing the new user
  222.      and frustrating the experienced user.
  223.  
  224.                                                                      Page 4   
  225.  
  226.      [C]  You CANNOT exchange help records!
  227.      -------------------------------------